<!DOCTYPE html>
<html>
  <head>
  <meta charset='UTF-8'>
  <title>Atom API Documentation</title>
  <link rel='stylesheet' href='../assets/biscotto.css' type='text/css'>
  <script src='../assets/biscotto.js'></script>
  <script src='../assets/search_data.js'></script>
</head>
  <body>
    <div id='base' data-path='..&#47;'></div>
<div id='header'>
  <div id='menu'>
    <a href='../docs/README.md.html' title='Atom'>Atom</a>
    &raquo;
    <a href='../class_index.html' title='Index'>Index</a>
    &raquo;
    <span class='title'>Git</span>
    <nav>
      <ul>
        <li class='noframes'>
          (<a class='noframes' href='Git.html#'>no frames</a>)
        </li>
      </ul>
    </nav>
    <div id='search'>
      <a id='class_list_link' href='../class_list.html'>Classes</a>
      <a id='file_list_link' href='../file_list.html'>Files</a>
      <a id='method_list_link' href='../method_list.html'>Methods</a>
      <a id='extra_list_link' href='../extra_list.html'>Extras</a>
    </div>
  </div>
  <iframe id='search_frame'></iframe>
  <div id='fuzzySearch'>
    <input type='text'>
    <ol></ol>
  </div>
  <div id='help'>
    <p>
      Quickly fuzzy find classes, mixins, methods, file:
    </p>
    <ul>
      <li>
        <span>Ctrl-T</span>
        Open fuzzy finder dialog
      </li>
    </ul>
    <p>
      In frame mode you can toggle the list naviation frame on the left side:
    </p>
    <ul>
      <li>
        <span>Ctrl-L</span>
        Toggle list view
      </li>
    </ul>
    <p>
      You can focus a list in frame mode or toggle a tab in frameless mode:
    </p>
    <ul>
      <li>
        <span>Ctrl-C</span>
        Class list
      </li>
      <li>
        <span>Ctrl-I</span>
        Mixin list
      </li>
      <li>
        <span>Ctrl-F</span>
        File list
      </li>
      <li>
        <span>Ctrl-M</span>
        Method list
      </li>
      <li>
        <span>Ctrl-E</span>
        Extras list
      </li>
    </ul>
    <p>
      You can focus and blur the search input:
    </p>
    <ul>
      <li>
        <span>Ctrl-S</span>
        Focus search input
      </li>
      <li>
        <span>Esc</span>
        Blur search input
      </li>
    </ul>
    <p>
      In frameless mode you can close the list tab:
    </p>
    <ul>
      <li>
        <span>Esc</span>
        Close list tab
      </li>
    </ul>
  </div>
</div>
    <div id='content'>
      <h1>
        Class
        Git
      </h1>
      <div class='stability-1'>
        <span class='heading'></span>
        <div class='message'></div>
      </div>
      <table class='box'>
        <tr>
          <td>Defined in:</td>
          <td>src&#47;git.coffee</td>
        </tr>
      </table>
      <h2>Overview</h2>
      <div class='docstring'>
  <p>Represents the underlying git operations performed by Atom.</p><p>This class shouldn&#39;t be instantiated directly but instead by accessing the
<code>atom.project</code> global and calling <code>getRepo()</code>. Note that this will only be
available when the project is backed by a Git repository.</p><h2 id="example">Example</h2>
<pre><code class="lang-coffeescript">git = atom.project.getRepo()
console.log git.getOriginUrl()
</code></pre>
<h2 id="requiring-in-packages">Requiring in packages</h2>
<pre><code class="lang-coffee">  {Git} = require &#39;atom&#39;
</code></pre>

</div>
<div class='tags'>
</div>
      <h2>Class Method Summary</h2>
      <ul class='summary'>
  <li>
    <span class='signature'>
      <a href='Git.html#open-class'>
        .<strong>open</strong>(path, options)
      </a>
    </span>
    <span class='desc'>
      Creates a new Git instance.
    </span>
  </li>
</ul>
      <h2>Instance Method Summary</h2>
      <ul class='summary'>
  <li>
    <span class='signature'>
      <a href='Git.html#checkoutHead-instance'>
        Boolean ::<strong>checkoutHead</strong>(path)
      </a>
    </span>
    <span class='desc'>
      Restore the contents of a path in the working directory and index to the version at <code>HEAD</code>.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Git.html#checkoutReference-instance'>
        ::<strong>checkoutReference</strong>(reference, create)
      </a>
    </span>
    <span class='desc'>
      Checks out a branch in your repository.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Git.html#destroy-instance'>
        ::<strong>destroy</strong>()
      </a>
    </span>
    <span class='desc'>
      Destroy this <code>Git</code> object.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Git.html#getAheadBehindCount-instance'>
        ::<strong>getAheadBehindCount</strong>(reference)
      </a>
    </span>
    <span class='desc'>
      Returns the number of commits behind the current branch is from the its upstream remote branch.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Git.html#getConfigValue-instance'>
        ::<strong>getConfigValue</strong>(key)
      </a>
    </span>
    <span class='desc'>
      Returns the git configuration value specified by the key.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Git.html#getDiffStats-instance'>
        Object ::<strong>getDiffStats</strong>(path)
      </a>
    </span>
    <span class='desc'>
      Retrieves the number of lines added and removed to a path.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Git.html#getDirectoryStatus-instance'>
        Number ::<strong>getDirectoryStatus</strong>(directoryPath)
      </a>
    </span>
    <span class='desc'>
      Get the status of a directory in the repository&#39;s working directory.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Git.html#getLineDiffs-instance'>
        Array ::<strong>getLineDiffs</strong>(path, text)
      </a>
    </span>
    <span class='desc'>
      Retrieves the line diffs comparing the <code>HEAD</code> version of the given path and the given text.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Git.html#getOriginUrl-instance'>
        ::<strong>getOriginUrl</strong>()
      </a>
    </span>
    <span class='desc'>
      Returns the origin url of the repository.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Git.html#getPath-instance'>
        ::<strong>getPath</strong>()
      </a>
    </span>
    <span class='desc'>
      Returns the <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String'>String</a> path of the repository.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Git.html#getPathStatus-instance'>
        Number ::<strong>getPathStatus</strong>(path)
      </a>
    </span>
    <span class='desc'>
      Get the status of a single path in the repository.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Git.html#getReferenceTarget-instance'>
        ::<strong>getReferenceTarget</strong>(reference)
      </a>
    </span>
    <span class='desc'>
      Returns the current SHA for the given reference.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Git.html#getReferences-instance'>
        Object ::<strong>getReferences</strong>()
      </a>
    </span>
    <span class='desc'>
      Gets all the local and remote references.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Git.html#getShortHead-instance'>
        String ::<strong>getShortHead</strong>()
      </a>
    </span>
    <span class='desc'>
      Retrieves a shortened version of the HEAD reference value.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Git.html#getUpstreamBranch-instance'>
        String ::<strong>getUpstreamBranch</strong>()
      </a>
    </span>
    <span class='desc'>
      Returns the upstream branch for the current HEAD, or null if there is no upstream branch for the current HEAD.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Git.html#getWorkingDirectory-instance'>
        ::<strong>getWorkingDirectory</strong>()
      </a>
    </span>
    <span class='desc'>
      Returns the <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String'>String</a> working directory path of the repository.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Git.html#hasBranch-instance'>
        ::<strong>hasBranch</strong>(branch)
      </a>
    </span>
    <span class='desc'>
      Returns true if the given branch exists.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Git.html#isPathIgnored-instance'>
        Boolean ::<strong>isPathIgnored</strong>(path)
      </a>
    </span>
    <span class='desc'>
      Is the given path ignored?
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Git.html#isPathModified-instance'>
        ::<strong>isPathModified</strong>(path)
      </a>
    </span>
    <span class='desc'>
      Returns true if the given path is modified.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Git.html#isPathNew-instance'>
        ::<strong>isPathNew</strong>(path)
      </a>
    </span>
    <span class='desc'>
      Returns true if the given path is new.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Git.html#isProjectAtRoot-instance'>
        ::<strong>isProjectAtRoot</strong>()
      </a>
    </span>
    <span class='desc'>
      Returns true if at the root, false if in a subfolder of the repository.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Git.html#isStatusModified-instance'>
        ::<strong>isStatusModified</strong>(status)
      </a>
    </span>
    <span class='desc'>
      Returns true if the given status indicates modification.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Git.html#isStatusNew-instance'>
        ::<strong>isStatusNew</strong>(status)
      </a>
    </span>
    <span class='desc'>
      Returns true if the given status indicates a new path.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Git.html#isSubmodule-instance'>
        Boolean ::<strong>isSubmodule</strong>(path)
      </a>
    </span>
    <span class='desc'>
      Is the given path a submodule in the repository?
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Git.html#relativize-instance'>
        ::<strong>relativize</strong>(path)
      </a>
    </span>
    <span class='desc'>
      Makes a path relative to the repository&#39;s working directory.
    </span>
  </li>
</ul>
      <h2>Class Method Details</h2>
      <div class='methods'>
  <div class='method_details'>
    <p class='signature' id='open-class'>
      .<strong>open</strong>(path, options)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Creates a new Git instance.</p>
</div>
<div class='tags'>
  <h3>Parameters:</h3>
  <ul class='param'>
    <li>
      <span class='name'>path</span>
      &mdash;
      <span class='desc'>The path to the Git repository to open.</span>
    </li>
    <li>
      <span class='name'>options</span>
      &mdash;
      <span class='desc'>An object with the following keys (default: {}):</span>
    </li>
    <ul class='options'>
      <li>
        <span class='name'>refreshOnWindowFocus</span>
        &mdash;
        <span class='desc'><code>true</code> to refresh the index and statuses when the window is focused.</span>
      </li>
    </ul>
  </ul>
  <h3>Returns:</h3>
  <ul class='return'>
    <li>
      <span class='type'></span>
      <span class='desc'>Returns a Git instance or null if the repository could not be opened.</span>
    </li>
  </ul>
</div>
  </div>
</div>
      <h2>Instance Method Details</h2>
      <div class='methods'>
  <div class='method_details'>
    <p class='signature' id='checkoutHead-instance'>
      Boolean ::<strong>checkoutHead</strong>(path)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Restore the contents of a path in the working directory and index to the version at <code>HEAD</code>.</p><p>This is essentially the same as running:</p><pre><code>git reset HEAD -- &lt;path&gt;
git checkout HEAD -- &lt;path&gt;
</code></pre>
</div>
<div class='tags'>
  <h3>Parameters:</h3>
  <ul class='param'>
    <li>
      <span class='type'>(String)</span>
      <span class='name'>path</span>
      &mdash;
      <span class='desc'>The <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String'>String</a> path to checkout.</span>
    </li>
  </ul>
  <h3>Returns:</h3>
  <ul class='return'>
    <li>
      <span class='type'></span>
      (<tt>Boolean</tt>)
      &mdash;
      <span class='desc'>Returns a <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Boolean'>Boolean</a> that&#39;s true if the method was successful.</span>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='checkoutReference-instance'>
      ::<strong>checkoutReference</strong>(reference, create)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Checks out a branch in your repository.</p>
</div>
<div class='tags'>
  <h3>Parameters:</h3>
  <ul class='param'>
    <li>
      <span class='name'>reference</span>
      &mdash;
      <span class='desc'>The String reference to checkout</span>
    </li>
    <li>
      <span class='name'>create</span>
      &mdash;
      <span class='desc'>A Boolean value which, if true creates the new reference if it doesn&#39;t exist.</span>
    </li>
  </ul>
  <h3>Returns:</h3>
  <ul class='return'>
    <li>
      <span class='type'></span>
      <span class='desc'>Returns a Boolean that&#39;s true if the method was successful.</span>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='destroy-instance'>
      ::<strong>destroy</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Destroy this <code>Git</code> object. This destroys any tasks and subscriptions and releases the underlying libgit2 repository handle.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getAheadBehindCount-instance'>
      ::<strong>getAheadBehindCount</strong>(reference)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Returns the number of commits behind the current branch is from the its upstream remote branch.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getConfigValue-instance'>
      ::<strong>getConfigValue</strong>(key)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Returns the git configuration value specified by the key.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getDiffStats-instance'>
      Object ::<strong>getDiffStats</strong>(path)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Retrieves the number of lines added and removed to a path.</p><p>This compares the working directory contents of the path to the <code>HEAD</code>
version.</p>
</div>
<div class='tags'>
  <h3>Parameters:</h3>
  <ul class='param'>
    <li>
      <span class='type'>(String)</span>
      <span class='name'>path</span>
      &mdash;
      <span class='desc'>The <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String'>String</a> path to check.</span>
    </li>
  </ul>
  <h3>Returns:</h3>
  <ul class='return'>
    <li>
      <span class='type'></span>
      (<tt>Object</tt>)
      &mdash;
      <span class='desc'>Returns an <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object'>Object</a> with the following keys:</span>
      <ul class='options'>
        <li>
          <span class='type'>(Number)</span>
          <span class='name'>added</span>
          &mdash;
          <span class='desc'>The <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number'>Number</a> of added lines.</span>
        </li>
        <li>
          <span class='type'>(Number)</span>
          <span class='name'>deleted</span>
          &mdash;
          <span class='desc'>The <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number'>Number</a> of deleted lines.</span>
        </li>
      </ul>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getDirectoryStatus-instance'>
      Number ::<strong>getDirectoryStatus</strong>(directoryPath)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Get the status of a directory in the repository&#39;s working directory.</p>
</div>
<div class='tags'>
  <h3>Parameters:</h3>
  <ul class='param'>
    <li>
      <span class='type'>(String)</span>
      <span class='name'>path</span>
      &mdash;
      <span class='desc'>The <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String'>String</a> path to check.</span>
    </li>
  </ul>
  <h3>Returns:</h3>
  <ul class='return'>
    <li>
      <span class='type'></span>
      (<tt>Number</tt>)
      &mdash;
      <span class='desc'>Returns a <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number'>Number</a> representing the status. This value can be passed to
<a href='Git.html#isStatusModified-instance'>::isStatusModified</a> or <a href='Git.html#isStatusNew-instance'>::isStatusNew</a> to get more information.</span>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getLineDiffs-instance'>
      Array ::<strong>getLineDiffs</strong>(path, text)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Retrieves the line diffs comparing the <code>HEAD</code> version of the given path and the given text.</p>
</div>
<div class='tags'>
  <h3>Parameters:</h3>
  <ul class='param'>
    <li>
      <span class='type'>(String)</span>
      <span class='name'>path</span>
      &mdash;
      <span class='desc'>The <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String'>String</a> path relative to the repository.</span>
    </li>
    <li>
      <span class='type'>(String)</span>
      <span class='name'>text</span>
      &mdash;
      <span class='desc'>The <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String'>String</a> to compare against the <code>HEAD</code> contents</span>
    </li>
  </ul>
  <h3>Returns:</h3>
  <ul class='return'>
    <li>
      <span class='type'></span>
      (<tt>Array</tt>)
      &mdash;
      <span class='desc'>Returns an <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Array'>Array</a> of hunk <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object'>Object</a>s with the following keys:</span>
      <ul class='options'>
        <li>
          <span class='type'>(Number)</span>
          <span class='name'>oldStart</span>
          &mdash;
          <span class='desc'>The line <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number'>Number</a> of the old hunk.</span>
        </li>
        <li>
          <span class='type'>(Number)</span>
          <span class='name'>newStart</span>
          &mdash;
          <span class='desc'>The line <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number'>Number</a> of the new hunk.</span>
        </li>
        <li>
          <span class='type'>(Number)</span>
          <span class='name'>oldLines</span>
          &mdash;
          <span class='desc'>The <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number'>Number</a> of lines in the old hunk.</span>
        </li>
        <li>
          <span class='type'>(Number)</span>
          <span class='name'>newLines</span>
          &mdash;
          <span class='desc'>The <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number'>Number</a> of lines in the new hunk</span>
        </li>
      </ul>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getOriginUrl-instance'>
      ::<strong>getOriginUrl</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Returns the origin url of the repository.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getPath-instance'>
      ::<strong>getPath</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Returns the <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String'>String</a> path of the repository.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getPathStatus-instance'>
      Number ::<strong>getPathStatus</strong>(path)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Get the status of a single path in the repository.</p>
</div>
<div class='tags'>
  <h3>Parameters:</h3>
  <ul class='param'>
    <li>
      <span class='type'>(String)</span>
      <span class='name'>path</span>
      &mdash;
      <span class='desc'>A <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String'>String</a> repository-relative path.</span>
    </li>
  </ul>
  <h3>Returns:</h3>
  <ul class='return'>
    <li>
      <span class='type'></span>
      (<tt>Number</tt>)
      &mdash;
      <span class='desc'>Returns a <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number'>Number</a> representing the status. This value can be passed to
<a href='Git.html#isStatusModified-instance'>::isStatusModified</a> or <a href='Git.html#isStatusNew-instance'>::isStatusNew</a> to get more information.</span>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getReferenceTarget-instance'>
      ::<strong>getReferenceTarget</strong>(reference)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Returns the current SHA for the given reference.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getReferences-instance'>
      Object ::<strong>getReferences</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Gets all the local and remote references.</p>
</div>
<div class='tags'>
  <h3>Returns:</h3>
  <ul class='return'>
    <li>
      <span class='type'></span>
      (<tt>Object</tt>)
      &mdash;
      <span class='desc'>Returns an <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object'>Object</a> with the following keys:</span>
      <ul class='options'>
        <li>
          <span class='type'>(Array)</span>
          <span class='name'>heads</span>
          &mdash;
          <span class='desc'>An <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Array'>Array</a> of head reference names.</span>
        </li>
        <li>
          <span class='type'>(Array)</span>
          <span class='name'>remotes</span>
          &mdash;
          <span class='desc'>An <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Array'>Array</a> of remote reference names.</span>
        </li>
        <li>
          <span class='type'>(Array)</span>
          <span class='name'>tags</span>
          &mdash;
          <span class='desc'>An <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Array'>Array</a> of tag reference names.</span>
        </li>
      </ul>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getShortHead-instance'>
      String ::<strong>getShortHead</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Retrieves a shortened version of the HEAD reference value.</p><p>This removes the leading segments of <code>refs/heads</code>, <code>refs/tags</code>, or
<code>refs/remotes</code>.  It also shortens the SHA-1 of a detached <code>HEAD</code> to 7
characters.</p>
</div>
<div class='tags'>
  <h3>Returns:</h3>
  <ul class='return'>
    <li>
      <span class='type'></span>
      (<tt>String</tt>)
      &mdash;
      <span class='desc'>Returns a <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String'>String</a>.</span>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getUpstreamBranch-instance'>
      String ::<strong>getUpstreamBranch</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Returns the upstream branch for the current HEAD, or null if there is no upstream branch for the current HEAD.</p>
</div>
<div class='tags'>
  <h3>Returns:</h3>
  <ul class='return'>
    <li>
      <span class='type'></span>
      (<tt>String</tt>)
      &mdash;
      <span class='desc'>Returns a <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String'>String</a> branch name such as <code>refs/remotes/origin/master</code>.</span>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getWorkingDirectory-instance'>
      ::<strong>getWorkingDirectory</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Returns the <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String'>String</a> working directory path of the repository.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='hasBranch-instance'>
      ::<strong>hasBranch</strong>(branch)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Returns true if the given branch exists.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='isPathIgnored-instance'>
      Boolean ::<strong>isPathIgnored</strong>(path)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Is the given path ignored?</p>
</div>
<div class='tags'>
  <h3>Returns:</h3>
  <ul class='return'>
    <li>
      <span class='type'></span>
      (<tt>Boolean</tt>)
      &mdash;
      <span class='desc'>Returns a <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Boolean'>Boolean</a>.</span>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='isPathModified-instance'>
      ::<strong>isPathModified</strong>(path)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Returns true if the given path is modified.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='isPathNew-instance'>
      ::<strong>isPathNew</strong>(path)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Returns true if the given path is new.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='isProjectAtRoot-instance'>
      ::<strong>isProjectAtRoot</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Returns true if at the root, false if in a subfolder of the repository.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='isStatusModified-instance'>
      ::<strong>isStatusModified</strong>(status)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Returns true if the given status indicates modification.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='isStatusNew-instance'>
      ::<strong>isStatusNew</strong>(status)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Returns true if the given status indicates a new path.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='isSubmodule-instance'>
      Boolean ::<strong>isSubmodule</strong>(path)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Is the given path a submodule in the repository?</p>
</div>
<div class='tags'>
  <h3>Parameters:</h3>
  <ul class='param'>
    <li>
      <span class='type'>(String)</span>
      <span class='name'>path</span>
      &mdash;
      <span class='desc'>The <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String'>String</a> path to check.</span>
    </li>
  </ul>
  <h3>Returns:</h3>
  <ul class='return'>
    <li>
      <span class='type'></span>
      (<tt>Boolean</tt>)
      &mdash;
      <span class='desc'>Returns a <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Boolean'>Boolean</a>.</span>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='relativize-instance'>
      ::<strong>relativize</strong>(path)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Makes a path relative to the repository&#39;s working directory.</p>
</div>
<div class='tags'>
</div>
  </div>
</div>
    </div>
    <div id='footer'>
  Generated on
  Thu Mar 06 2014 17:48:26 GMT-0800 (PST)
  by
  <a href='https://github.com/gjtorikian/biscotto' title='TomDoc-CoffeeScript API documentation generator'>Biscotto</a>
  v2.1.1
  (Node.js v0.10.21).
  &#10034;
  Press Ctrl-h to see the keyboard shortcuts
</div>
  </body>
</html>